home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / share / perl5 / Mail / Field / Date.pod < prev    next >
Encoding:
Text File  |  2008-07-29  |  2.4 KB  |  161 lines
  1. =head1 NAME
  2.  
  3. Mail::Field::Date - a date header field
  4.  
  5. =head1 INHERITANCE
  6.  
  7.  Mail::Field::Date
  8.    is a Mail::Field
  9.  
  10. =head1 SYNOPSIS
  11.  
  12.   use HTTP::Date 'time2iso';
  13.   my $field = Mail::Field->new(Date => time2iso());
  14.  
  15. =head1 DESCRIPTION
  16.  
  17. Represents one "Date" header field.
  18.  
  19. =head1 METHODS
  20.  
  21. =head2 Constructors
  22.  
  23. Mail::Field::Date-E<gt>B<combine>(FIELDS)
  24.  
  25. =over 4
  26.  
  27. See L<Mail::Field/"Constructors">
  28.  
  29. =back
  30.  
  31. Mail::Field::Date-E<gt>B<extract>(TAG, HEAD [, INDEX ])
  32.  
  33. =over 4
  34.  
  35. See L<Mail::Field/"Constructors">
  36.  
  37. =back
  38.  
  39. Mail::Field::Date-E<gt>B<new>(TAG [, STRING | OPTIONS])
  40.  
  41. =over 4
  42.  
  43. See L<Mail::Field/"Constructors">
  44.  
  45. =back
  46.  
  47. =head2 "Fake" constructors
  48.  
  49. $obj-E<gt>B<create>(OPTIONS)
  50.  
  51. =over 4
  52.  
  53. See L<Mail::Field/""Fake" constructors">
  54.  
  55. =back
  56.  
  57. $obj-E<gt>B<parse>
  58.  
  59. =over 4
  60.  
  61. See L<Mail::Field/""Fake" constructors">
  62.  
  63. =back
  64.  
  65. =head2 Accessors
  66.  
  67. $obj-E<gt>B<set>(OPTIONS)
  68.  
  69. =over 4
  70.  
  71.  Option --Default
  72.  Time     undef
  73.  TimeStr  undef
  74.  
  75. . Time => SECONDS
  76.  
  77. . TimeStr => STRING
  78.  
  79. =over 4
  80.  
  81. A string acceptable to Date::Parse.
  82.  
  83. =back
  84.  
  85. =back
  86.  
  87. $obj-E<gt>B<stringify>
  88.  
  89. =over 4
  90.  
  91. See L<Mail::Field/"Accessors">
  92.  
  93. =back
  94.  
  95. $obj-E<gt>B<tag>
  96.  
  97. Mail::Field::Date-E<gt>B<tag>
  98.  
  99. =over 4
  100.  
  101. See L<Mail::Field/"Accessors">
  102.  
  103. =back
  104.  
  105. =head2 Smart accessors
  106.  
  107. $obj-E<gt>B<text>([STRING])
  108.  
  109. =over 4
  110.  
  111. See L<Mail::Field/"Smart accessors">
  112.  
  113. =back
  114.  
  115. $obj-E<gt>B<time>([TIME])
  116.  
  117. =over 4
  118.  
  119. Query (or change) the TIME (as stored in the field) in seconds.
  120.  
  121. =back
  122.  
  123. =head1 DETAILS
  124.  
  125. =head1 DIAGNOSTICS
  126.  
  127. Error: Undefined subroutine <method> called
  128.  
  129. =over 4
  130.  
  131. Mail::Field objects use autoloading to compile new functionality.
  132. Apparently, the mehod called is not implemented for the specific
  133. class of the field object.
  134.  
  135. =back
  136.  
  137. =head1 SEE ALSO
  138.  
  139. This module is part of the MailTools distribution,
  140. F<http://perl.overmeer.net/mailtools/>.
  141.  
  142. =head1 AUTHORS
  143.  
  144. The MailTools bundle was developed by Graham Barr.  Later, Mark
  145. Overmeer took over maintenance without commitment to further development.
  146.  
  147. Mail::Cap by Gisle Aas E<lt>aas@oslonett.noE<gt>.
  148. Mail::Field::AddrList by Peter Orbaek E<lt>poe@cit.dkE<gt>.
  149. Mail::Mailer and Mail::Send by Tim Bunce E<lt>Tim.Bunce@ig.co.ukE<gt>.
  150. For other contributors see ChangeLog.
  151.  
  152. =head1 LICENSE
  153.  
  154. Copyrights 1995-2000 Graham Barr E<lt>gbarr@pobox.comE<gt> and
  155. 2001-2007 Mark Overmeer E<lt>perl@overmeer.netE<gt>.
  156.  
  157. This program is free software; you can redistribute it and/or modify it
  158. under the same terms as Perl itself.
  159. See F<http://www.perl.com/perl/misc/Artistic.html>
  160.  
  161.